Границы обращения к метаданным #1837

Golovanoff · 2021-09-23T11:29:11Z

Описание

Диагностика позволяет найти обращение к метаданным (через поиск регулярным выражением) за пределами указанных границ. Например, вне какого-то определенного общего модуля.

Связанные задачи

Closes

Чеклист

Общие

Ветка PR обновлена из develop
Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
Изменения покрыты тестами
Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)

Дополнительно

# Conflicts: # docs/diagnostics/index.md # docs/en/diagnostics/index.md

Обновление из головного репо

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

artbear · 2021-09-23T13:44:29Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+
+    for (Map.Entry<String, String> entry: metadataBordersParameters.entrySet()) {
+
+      if (entry.getKey().isBlank() || entry.getValue().isBlank()) {


это условие нужно проверять на этапе configure

и создавать мапу без неверных значений

artbear

есть замечания

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

Golovanoff · 2021-09-26T06:27:22Z

поправил замечания

artbear

и еще немного предложений по оптимизации

...com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_ru.properties

...com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_en.properties

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

Golovanoff · 2021-09-28T09:42:01Z

заработало через visitFile

artbear

Есть вопросы

...main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

docs/diagnostics/MetadataBorders.md

…з json.

docs/diagnostics/MetadataBorders.md

nixel2007 · 2021-10-06T19:47:54Z

docs/diagnostics/MetadataBorders.md

+
+|             Имя             |   Тип    |                                                   Описание                                                   |    Значение<br>по умолчанию    |
+|:---------------------------:|:--------:|:------------------------------------------------------------------------------------------------------------:|:------------------------------:|
+| `metadataBordersParameters` | `Строка` | `JSON-структура для пар "регулярное выражение для операторов":"регулярное выражение для имени файла модуля"` |               ``               |


Где-то в ранних версиях здесь был пример заполнения. Кажется, стоит его вернуть. Плюс добавить {}

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

nixel2007 · 2021-10-06T19:52:56Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+  private List<Pattern> statementPatterns = Collections.emptyList();
+
+  private static Map<Pattern, Pattern> MapFromJSON(String userSettings) {
+    ObjectMapper mapper = new ObjectMapper();


создание ObjectMapper на каждый configure - довольно дорогая операция. лучше его закэшировать или просто указать его конструкторе - его туда подложит спринг.

nixel2007 · 2021-10-06T19:53:43Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+
+  private static Map<Pattern, Pattern> MapFromJSON(String userSettings) {
+    ObjectMapper mapper = new ObjectMapper();
+    MapType mapType = mapper.getTypeFactory().constructMapType(HashMap.class, String.class, String.class);


mapType тоже можно закэшировать в конструторе по принятому инстансу обджект-маппера

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

nixel2007 · 2021-10-06T20:00:17Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+      Map<String, String> stringMap = mapper.readValue(userSettings, mapType);
+      return stringMap.entrySet().stream()
+        .filter(entry -> ! entry.getKey().isBlank() && ! entry.getValue().isBlank())
+        .collect(Collectors.toMap(


пробовал делать включать замер производительности? диагностика не вырывается в топ?

nixel2007 · 2021-10-06T20:05:20Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+      }
+    });
+
+    return super.visitStatement(ctx);


если ты проверяешь текст statement целиком, то нет смысла дергать super, т.к. вложенные стэйтменты проверят тот же самый кусок текста. т.е. здесь будет фонить на вложенных конструкциях вида

Если Истина Тогда Если Истина Тогда ЗапрещенныйВызов(); // тут кинет два срабатывания на одно и то же место КонецЕсли; КонецЕсли;

...main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

nixel2007 · 2021-10-06T20:07:27Z

...com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_ru.properties

@@ -0,0 +1,3 @@
+diagnosticMessage=Обращение к метаданным за пределами разрешенных границ


может быть в сообщение стоит добавить регулярку/пару регулярок, на которой произошло срабатывание?

nixel2007 · 2021-10-07T08:54:42Z

docs/diagnostics/MetadataBorders.md

-| `metadataBordersParameters` | `Строка` | `JSON-структура для пар "регулярное выражение для операторов":"регулярное выражение для имени файла модуля"` |               ``               |
+|             Имя             |   Тип    |                                        Описание                                         |    Значение<br>по умолчанию    |
+|:---------------------------:|:--------:|:---------------------------------------------------------------------------------------:|:------------------------------:|
+| `metadataBordersParameters` | `Строка` | `{"регулярное выражение для операторов":"регулярное выражение для имени файла модуля"}` |               ``               |


стало еще менее понятно :(

Предлагаю что-то вроде:

Строка в виде объекта JSON (в фигурных скобках) с перечислением пар "регулярное выражение для операторов": "регулярное выражение для имени файла модуля". Например, `{"Регистры?Сведений.КонтактнаяИнформация": "CommonModules/РаботаСКонтактами"}`.

Пускай пример будет прям в описании параметра, упростит понимание.

theshadowco · 2021-10-07T09:36:19Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+  @Override
+  public ParseTree visitFile(BSLParser.FileContext ctx) {
+    statementPatterns = metadataBordersParameters.entrySet().stream()
+                      .filter(entry -> ! entry.getValue().matcher(documentContext.getUri().getPath()).find())


а почему пути к файлам используются? почему не mdoRef?

ну и стоит проверять заполненность statementPatterns: для пустой делать возврат и не греть воздух

а почему пути к файлам используются? почему не mdoRef?

вообще у нее scope захватывает OS, а для оскрипта mdoRef сейчас выглядит в виде uri. с другой стороны, вряд ли ее кто-то будет включать на os

таки да. по-хорошему, если делать универсальненько и для людей, то надо вообще переделать, как Никита предлагал в телеге - на вхождение в подсистему.
но я такого пока не умею, это ж надо еще и тесты менять - конфу запихивать, разбираться с этим.

ну и стоит проверять заполненность statementPatterns: для пустой делать возврат и не греть воздух

это сделано при формировании мапы паттернов. из стринговой мапы в мапу щаблонов попадают только те элементы, в которых и ключ, и значение не пустые

theshadowco · 2021-10-07T09:39:05Z

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

+
+    statementPatterns.forEach(pattern -> {
+      Matcher matcher = pattern.matcher(ctx.getText());
+      while (matcher.find()) {


вообще не понял - а цикл зачем?

потому что матчер возвращает срабатывание по одному за раз

а зачем одну и туже диагностику в цикле добавлять?

100 раз "addDiagnostic(ctx)"

так, стоп, тут же где-то был другой код, когда в addDiagnostic передается start() и end() от матчера... или это в соседней диагностике?)

theshadowco · 2024-06-04T06:33:43Z

@Golovanoff @nixel2007
реквест висит давно. что делать с ним? переначать ?

Golovanoff · 2024-06-04T08:12:37Z

был артуррилион замечаний, я поправил, пришел Никита и спросил "а нафига так-то? ". на этом моменте я сломался 😀
диагностика у меня в конторе работает, пользу приносит, а как ее переделать, чтобы ее приняли в мейн - я хз 😀

Голованов Сергей and others added 12 commits September 10, 2021 07:35

отработал Gradle, заготовки под диагностику

cd9ef8b

переименовал правильно

768ab7d

настройку думаю сделать мапой. читать ее из json?

ea1e7dd

попытался накидать чтение настройки из json. но не взлетает

b17d97f

сделал параметр сразу мапой

2bc45e1

работающий вариант

f06515a

документация

65557a8

# Conflicts: # docs/diagnostics/index.md # docs/en/diagnostics/index.md

документация

fdad879

# Conflicts: # docs/diagnostics/index.md # docs/en/diagnostics/index.md

убрал ворнинг на каст мапы

8912ca2

Merge pull request #1 from 1c-syntax/develop

36f4e78

Обновление из головного репо

Смержил с develop

f05deaa

Сделал диагностику отключенной по умолчанию

1248793

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

artbear reviewed Sep 23, 2021

View reviewed changes

artbear suggested changes Sep 23, 2021

View reviewed changes

artbear reviewed Sep 24, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

Golovanoff added 2 commits September 26, 2021 13:19

перетащил компиляцию паттернов и их фильтрацию в configure

1379891

поправил импорты

84e4d9d

artbear suggested changes Sep 26, 2021

View reviewed changes

оптимизация - переписал через visitFile

7171d3f

artbear suggested changes Sep 30, 2021

View reviewed changes

Убрал переносы строк из описания диагностики, вычистил левые строки и…

239f1c0

…з json.

nixel2007 reviewed Oct 6, 2021

View reviewed changes

docs/diagnostics/MetadataBorders.md Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

docs/diagnostics/MetadataBorders.md Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

docs/diagnostics/MetadataBorders.md Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

...ain/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

...main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json Outdated Show resolved Hide resolved

nixel2007 reviewed Oct 6, 2021

View reviewed changes

Поправил документацию и имя функции, убрал this.

5ce7014

nixel2007 reviewed Oct 7, 2021

View reviewed changes

theshadowco reviewed Oct 7, 2021

View reviewed changes

nixel2007 added the pr/waits-for-feedback label Oct 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Границы обращения к метаданным #1837

Границы обращения к метаданным #1837

Golovanoff commented Sep 23, 2021 •

edited

Loading

artbear Sep 23, 2021

artbear left a comment

Golovanoff commented Sep 26, 2021

artbear left a comment

Golovanoff commented Sep 28, 2021

artbear left a comment

nixel2007 Oct 6, 2021 •

edited

Loading

nixel2007 Oct 6, 2021

nixel2007 Oct 6, 2021

nixel2007 Oct 6, 2021

nixel2007 Oct 6, 2021

nixel2007 Oct 6, 2021

nixel2007 Oct 7, 2021

theshadowco Oct 7, 2021

theshadowco Oct 7, 2021

nixel2007 Oct 7, 2021

Golovanoff Oct 7, 2021 •

edited

Loading

Golovanoff Oct 7, 2021

theshadowco Oct 7, 2021

nixel2007 Oct 7, 2021

theshadowco Oct 7, 2021

theshadowco Oct 7, 2021

nixel2007 Oct 7, 2021

theshadowco commented Jun 4, 2024

Golovanoff commented Jun 4, 2024


		for (Map.Entry<String, String> entry: metadataBordersParameters.entrySet()) {

		if (entry.getKey().isBlank() \|\| entry.getValue().isBlank()) {

		@@ -0,0 +1,3 @@
		diagnosticMessage=Обращение к метаданным за пределами разрешенных границ

Границы обращения к метаданным #1837

Are you sure you want to change the base?

Границы обращения к метаданным #1837

Conversation

Golovanoff commented Sep 23, 2021 • edited Loading

Описание

Связанные задачи

Чеклист

Общие

Для диагностик

Дополнительно

Choose a reason for hiding this comment

artbear left a comment

Choose a reason for hiding this comment

Golovanoff commented Sep 26, 2021

artbear left a comment

Choose a reason for hiding this comment

Golovanoff commented Sep 28, 2021

artbear left a comment

Choose a reason for hiding this comment

nixel2007 Oct 6, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Golovanoff Oct 7, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theshadowco commented Jun 4, 2024

Golovanoff commented Jun 4, 2024

Golovanoff commented Sep 23, 2021 •

edited

Loading

nixel2007 Oct 6, 2021 •

edited

Loading

Golovanoff Oct 7, 2021 •

edited

Loading